Delete Customer Address

This API is used to delete one or more customer addresses. Deletion is done as a soft deletion procedure. When sending a request to delete multiple addresses in a single call, the result treats them as a single instance so that the result is either All Succeed, or All Fail. Sending address IDs for deletion, both as part of the URL and in the request itself, will result in a “bad request” notification.

HTTP URL  
DELETE /api/v2/customer/{id}/address/{id}

Eligibility

The Requester is eligible to request to delete addresses for its own sub-customers only (one level). The Requester is not allowed to delete customer addresses on its own account level or for any other customers.

API Request

Request Structure

Element Type M/O/CM Description
id UUID O List of Address IDs to be deleted

API Response

Response Structure

Parameter Type M/O/CM Description
errorCode String O Failure code.
errorMessage String O Failure message.
content Object O Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable Object O Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content Data Objects

Element Type M/O/CM Description
requestId UUID M

Request instance ID.

To be used by external systems to query the call (operation) status:

  • In progress

  • Successful

  • Failed

Pageable Data Objects

Element Type M/O/CM Description
page Numeric M Page number
size Numeric M Page size. Number of requested elements per page
totalPages Numeric M Total amount of available pages per requested page size
totalElements Numeric M Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code Message
GLOBAL_1001 Service unavailable. Please try again
CUSTOMER_1002 Customer does not exist
AUTH_1011 Address for your customer was not found
CUSTOMER_1018 Unknown Address ID

Examples

Request Body

Copy 
{  
  "id": [
    "e7fcef24-5c03-41dd-9e33-995b7d6f32b1",
    "ceb892d2-f24b-4007-bf81-999fe75cb635"
  ]
}

Response Body: Success ACK

Copy 
{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Failure NAK

Copy 
{
  "errorCode": "AUTH_1011",
  "errorMessage": "Address for your account was not found",
  "content": "",
  "pageable": ""
}